Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change quickstart example README.md to point to docs. #800

Merged
merged 4 commits into from
Sep 28, 2023

Conversation

markmandel
Copy link
Member

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug

/kind cleanup

/kind documentation
/kind feature
/kind hotfix

What this PR does / Why we need it:

We had duplicate documentation in both our quickstarts and the in the folders for their code references as well.

Changed the README to just specify which Guide title to look for in the docs.

I didn't link them directly, as links change, and we don't know which version of Quilkin the end user is using.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

N/A

We had duplicate documentation in both our quickstarts and the in the
folders for their code references as well.

Changed the README to just specify which Guide title to look for in the
docs.

I didn't link them directly, as links change, and we don't know which
version of Quilkin the end user is using.
@markmandel markmandel added kind/documentation Improvements or additions to documentation area/examples Examples. Usually found in the `examples` directory kind/cleanup Refactoring code, fixing up documentation, etc labels Sep 22, 2023
@XAMPPRocky XAMPPRocky enabled auto-merge (squash) September 22, 2023 22:37
@markmandel markmandel added this to the 0.7.0 milestone Sep 27, 2023
@markmandel markmandel requested a review from koslib as a code owner September 28, 2023 22:14
@XAMPPRocky XAMPPRocky merged commit 52bfe6a into googleforgames:main Sep 28, 2023
3 checks passed
@quilkin-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 43cf3870-d831-4d47-b2ca-7e42bd44c6f9

The following development images have been built, and will exist for the next 30 days:

To build this version:

git fetch [email protected]:googleforgames/quilkin.git pull/800/head:pr_800 && git checkout pr_800
cargo build

@markmandel markmandel deleted the examples/cleanup-readme branch September 29, 2023 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/examples Examples. Usually found in the `examples` directory kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Improvements or additions to documentation size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants